

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Rules for commit messages &mdash; Anaconda 25.14 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Anaconda 25.14 documentation" href="index.html"/>
        <link rel="next" title="Brief description of DriverDisc version 3" href="driverdisc.html"/>
        <link rel="prev" title="Anaconda Kickstart Documentation" href="kickstart.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> Anaconda
          

          
          </a>

          
            
            
              <div class="version">
                25.14
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Building a Release</a></li>
<li class="toctree-l1"><a class="reference internal" href="boot-options.html">Anaconda Boot Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="kickstart.html">Anaconda Kickstart Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Rules for commit messages</a></li>
<li class="toctree-l1"><a class="reference internal" href="driverdisc.html">Brief description of DriverDisc version 3</a></li>
<li class="toctree-l1"><a class="reference internal" href="iscsi.html">iSCSI and Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="multipath.html">Multipath and Anaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">pyanaconda</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests/modules.html">tests</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">Anaconda</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          





<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li>Rules for commit messages</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/commit-log.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="rules-for-commit-messages">
<h1>Rules for commit messages<a class="headerlink" href="#rules-for-commit-messages" title="Permalink to this headline">¶</a></h1>
<p>git commit messages for anaconda should follow a consistent format.  The
following are rules to follow when committing a change to the git repo:</p>
<ol class="arabic">
<li><p class="first">The first line of the commit message should be a short summary of the
change in the patch.  We also place (#BUGNUMBER) at the end of this
line to indicate the bugzilla.redhat.com bug number addressed in this
patch.  The bug number is optional since there may be no bug number,
but if you have one you are addressing, please include it on the
summary line.  Lastly, the summary lines need to be short.  Ideally
less than 75 characters, but certainly not longer than 80.</p>
<p>Here are acceptable first lines for git commit messages:</p>
<blockquote>
<div><p>Check partition and filesystem type on upgrade (#123456)
Fix bootloader configuration setup on ppc64 (#987654)
Introduce a new screen for setting your preferred email client</p>
</div></blockquote>
<p>The last one would be a new feature that we didn&#8217;t have a bug number
for.</p>
</li>
<li><p class="first">The main body of the commit message should begin TWO LINES below the
summary line you just entered (that is, there needs to be a blank line
between the one line summary and the start of the long commit message).
Please document the change and explain the patch here.  Use multiple
paragraphs and keep the lines &lt; 75 chars.  DO NOT indent these lines.
Everything in the git commit message should be left justified.  PLEASE
wrap long lines.  If you don&#8217;t, the &#8216;git log&#8217; output ends up looking
stupid on 80 column terminals.</p>
</li>
<li><p class="first">For RHEL bugs, all commits need to reference a bug number.  You may
follow one of two formats for specifying the bug number in a RHEL commit.</p>
<ol class="loweralpha">
<li><p class="first">Put the bug number on the summary line in (#BUGNUMBER) format.  Bugs
listed this way are treated as &#8216;Resolves&#8217; patches in the RHEL
universe.</p>
</li>
<li><p class="first">If you have a patch that is Related to or Conflicts with another bug,
you may add those lines to the end of the long commit message in this
format:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span>Related: rhbz#BUGNUMBER
Conflicts: rhbz#BUGNUMBER
Resolves: rhbz#BUGNUMBER
</pre></div>
</div>
<p>These entries should come at the end of the long commit message and
must follow the format above.  You may have as many of these lines as
appropriate for the patch.</p>
</li>
<li><p class="first">Patches that are &#8216;Resolves&#8217; patches have two methods to specify the
bug numbers, but Related and Conflicts can only be listed in the long
commit message.</p>
</li>
</ol>
<p>On RHEL branches, the &#8216;bumpver&#8217; process will verify that each patch for
the release references a RHEL bug number.  The scripts/makebumpver script
will extract the bug numbers from RHEL branch commits and do two things.
First, it verifies that the bug referenced is a RHEL bug and in correct
states.  Second, it adds the appropriate Resolves/Related/Conflicts line
to the RPM spec file changelog.</p>
</li>
</ol>
<p>It is recommended to use the pre-push hook checking commit messages for RHEL bug
numbers and checking the referenced bugs for all the necessary acks. To make it
work, just copy the scripts/githooks/pre-push and
scripts/githooks/check_commit_msg.sh scripts to the .git/hooks/ directory.</p>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="driverdisc.html" class="btn btn-neutral float-right" title="Brief description of DriverDisc version 3" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="kickstart.html" class="btn btn-neutral" title="Anaconda Kickstart Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2015, Red Hat, Inc..

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'25.14',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>